home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d1 / anarkey3.arc / ANARKED.DOC next >
Text File  |  1989-09-24  |  19KB  |  442 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.                                     ANARKED
  10.                            The ANARKEY Keystroke Editor
  11.                                   User Manual
  12.  
  13.                                   Version 3.00
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.                                 Steven Calwas
  37.                                Moderne Software
  38.                                 P.O. Box 3638
  39.                           Santa Clara, CA 95055-3638
  40.  
  41.  
  42.                               _______
  43.                          ____|__     |               (tm)
  44.                       --|       |    |-------------------
  45.                         |   ____|__  |  Association of
  46.                         |  |       |_|  Shareware
  47.                         |__|   o   |    Professionals
  48.                       -----|   |   |---------------------
  49.                            |___|___|    MEMBER
  50.  
  51.  
  52.  
  53.  
  54.                               Copyright (C) 1989
  55.                                by Steven Calwas
  56.                               All rights reserved
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.                                Introduction
  69.                                ------------
  70.  
  71.    ANARKED is the ANARKEY keystroke editor.  It allows ANARKEY functions
  72. to be reassigned to keystrokes other than their default assignments.  With
  73. ANARKED, you can configure ANARKEY to perform like your word processor,
  74. previous command-line editor, or own personal tastes.
  75.  
  76.    ANARKED is not a TSR (Terminate-and-Stay-Resident) program.  ANARKED
  77. modifies the ANARKEY.COM disk file so that it will recognize the new
  78. keystroke assignments.  ANARKEY does not have to be installed to run
  79. ANARKED.  ANARKED will patch the ANARKEY.COM disk file, not the resident
  80. program.  After running ANARKED, the new keystroke assignments will be
  81. activated the next time you install ANARKEY.
  82.  
  83.  
  84.  
  85.                               Getting Started
  86.                               ---------------
  87.  
  88.    Simply execute ANARKED from the DOS command line or from a batch file.
  89. ANARKED will accept one optional command-line parameter.
  90.  
  91.         ANARKED [-U]
  92.  
  93.    Specify the -U option if you are upgrading from a previous version of
  94. ANARKEY (2.00 or later) to a later release.  ANARKED will allow you to carry
  95. over the key assignments of the earlier version to the new release.  This
  96. will save you from having to go through the entire key assignment operation
  97. each time you upgrade to a new version of ANARKEY.  The effects of
  98. specifying the -U option are described a little later.
  99.  
  100.    Note: The -U option is supported only in the registered version of
  101. ANARKED.  To receive a registered version, you must send in your paid
  102. registration form contained in the file ORDERFRM.  A registered copy of the
  103. entire ANARKEY software package will be sent to you immediately.
  104.  
  105.    When executed without the -U option, ANARKED will ask for the name and
  106. location of the ANARKEY.COM program file you wish to configure.  When
  107. executed under DOS version 3.00 and later, the default input file is
  108. ANARKEY.COM located in the same directory and drive from which ANARKED was
  109. executed.  If executed in an earlier version of DOS the default input file
  110. will be ANARKEY.COM in the current directory of the current drive.
  111. Whichever version of DOS you're running, the default input filename will be
  112. displayed.  Pressing the <Enter> key will accept the default.  To specify a
  113. different filename or location, type the file's drive, path and name
  114. specification and then press <Enter>.
  115.  
  116.    ANARKED will check the input file to verify it is a valid ANARKEY program
  117. file.  ANARKED will modify ANARKEY versions 2.00 or greater.  Earlier
  118. versions of ANARKEY are not modifiable.  If the program file is found to be
  119. invalid, an error message will appear and ANARKED will prompt for another
  120. input file.
  121.  
  122.    When upgrading (-U option), ANARKED will prompt you for two input files:
  123. (1) the original ANARKEY file whose key assignments you wish to carry over
  124. and (2) the new release ANARKEY file to which you are upgrading.  If both
  125. files are valid ANARKEY program files, the key assignments will be
  126. transferred from the old version to the new.
  127.  
  128.    All default key assignments to functions supported in the new release but
  129. not in the old version will be removed.  This is done to prevent any
  130. occurrences of a key being assigned to more than one function.  All new
  131. functions in a release will be documented in the UPDATE.DOC file included in
  132. each ANARKEY distribution package.  If there are any new functions in the
  133. new version, ANARKED will inform you by listing them in a window when the
  134. program is first executed.
  135.  
  136.    After transferring key assignments, the normal ANARKED operation will
  137. continue.
  138.  
  139.    Once all the required input files are specified, ANARKED will prompt for
  140. the output file.  Any changes you make during the ANARKED session will be
  141. stored in this output file.  By default, ANARKED will write the changes to
  142. the specified input file.  Pressing <Enter> will accept the default.  If you
  143. wish to save your changes to a different file, type in the desired file
  144. specification with optional drive and path.
  145.  
  146.    After specifying valid input and output files, ANARKED will display its
  147. main "command/keystroke window."
  148.  
  149.  
  150.  
  151.                       ANARKED Command/Keystroke Windows
  152.                       ---------------------------------
  153.  
  154.    A "command/keystroke window" is a full-screen window which contains a
  155. group of ANARKEY functions and their assigned keystrokes.  Since all of the
  156. ANARKEY functions cannot fit onscreen at once, they are divided into several
  157. windows.  Traversing through the windows is possible by pressing one of the
  158. action keys described below.
  159.  
  160.    Each ANARKEY function is displayed on a single line.  On each line is a
  161. function description and its keystroke invocations.  As displayed,
  162. keystrokes are surrounded by < > characters, for example <F1>.  These
  163. bracketing characters are not part of the keystroke invocation.  Any
  164. keystroke invocation that is not currently assigned is displayed as "<>".
  165.  
  166.    An ANARKEY function may have a maximum of two keystrokes assigned to it.
  167. For example, as shipped, the Find-History-Buffer-Match-and-Edit function is
  168. invoked by pressing either the <F5> or <Ctrl-K> keys.  Both of these
  169. keystrokes would share the line with the function description and would look
  170. something like this:
  171.  
  172.              Find match and edit      <F5>            <Ctrl-K>
  173.  
  174. The Active Keystroke Field
  175. --------------------------
  176.    One keystroke invocation in the window will be displayed in inverse
  177. video, meaning the characters are displayed on a bright background.  This
  178. keystroke is the "active keystroke field."  Keystroke assignments are always
  179. performed on the active keystroke field.
  180.  
  181. Action Keys
  182. -----------
  183.    There are seven "action" keys that, when pressed, cause ANARKED to
  184. perform a special operation.  The seven action keys are:
  185.  
  186.                 -- the arrow keys (Up, Down, Left and Right)
  187.                 -- <PgUp> and <PgDn>
  188.                 -- and <Esc>
  189.  
  190.    Pressing one of the arrow keys (Up, Down, Left or Right) will move the
  191. active keystroke field in the specified direction.  These keys are used to
  192. set the active field to any of the displayed keystroke invocations.
  193.  
  194.    All ANARKEY commands are modifiable with ANARKED, but, because they
  195. cannot all fit onscreen at once, commands are divided into several display
  196. windows.  Pressing the <PgUp> and <PgDn> keys will cycle through each of
  197. these windows.
  198.  
  199.    Pressing the <Esc> key will activate the "ANARKED Action Menu."  From the
  200. Action Menu you may perform special operations such as saving your changes,
  201. assigning one of the action keys to a function or quitting the program.
  202. Each Action Menu function is explained later in this manual.
  203.  
  204.  
  205.  
  206.                           Editing ANARKEY Keystrokes
  207.                           --------------------------
  208.  
  209. Assigning New Keystrokes
  210. ------------------------
  211.    Pressing any key (other than an action key) will immediately assign that
  212. key to the active keystroke field.  As an example, to assign <F1> to the
  213. active keystroke field, simply hit <F1>.
  214.  
  215.    This method makes it extremely easy to configure ANARKEY without the
  216. confusing configuration files or installation programs required by many word
  217. processors.
  218.  
  219.    Most of the keystroke combinations available on a keyboard may be
  220. assigned to an ANARKEY function.  These include:
  221.  
  222.                  <Alt>  -sequences, like <Alt-F1>  and <Alt-A>,
  223.                  <Ctrl> -sequences, like <Ctrl-F1> and <Ctrl-Z> and
  224.                  <Shift>-sequences, like <Shift-F1>.
  225.  
  226.    Some keys, however, are reserved by DOS for special handling, for
  227. example, <Ctrl-C> and <Ctrl-P>.  These DOS-reserved keystrokes may not be
  228. assigned to an ANARKEY function.  If you attempt such an assignment, ANARKED
  229. will refuse to carry out your request.
  230.  
  231.    Each particular keystroke may be assigned to a maximum of one ANARKEY
  232. function.  Obviously, it would not make sense to have a key assigned to two
  233. different functions.  If an attempt is made to assign a key to the active
  234. keystroke field and that key is already assigned to another function,
  235. ANARKED will display a window stating the function to which the key is
  236. currently assigned and asking if you wish to remove it.  If you wish to
  237. remove the current key assignment and assign the key to the active keystroke
  238. field, press 'Y' or <Enter>.  Pressing any other key will leave the original
  239. key assignment and active keystroke field unchanged.
  240.  
  241. Clearing Keystrokes
  242. -------------------
  243.    A particular keystroke invocation may be completely removed or cleared
  244. from a function by pressing the <Ctrl-@> key when the field is the active
  245. keystroke field.  Notice that you will have to hold down one of the <Shift>
  246. keys to enter a <Ctrl-@> keystroke.  In case you forget this field-clearing
  247. keystroke, the Action Menu (described below) can be used to perform the same
  248. operation.
  249.  
  250.    NOTE: The TOPS local area network will not correctly handle the <Ctrl-@>
  251. keystroke.  Either UNLOAD TOPS when running ANARKED or use the corresponding
  252. Action Menu operation to remove keystroke assignments.  TOPS may also
  253. interfere with the assignment of otherwise valid keystrokes.  If you have
  254. any problems assigning a particular key, UNLOAD TOPS and try again.
  255.  
  256. An Editing Example
  257. ------------------
  258.    As an example of editing a keystroke assignment, let's say you want to
  259. configure the Delete-to-End-of-Line function so it will be executed every
  260. time you press <F1>.
  261.  
  262.    First, use the <PgUp>/<PgDn> keys to display the window that contains the
  263. Delete-to-End-of-Line function.  Then use the arrow keys to move the active
  264. keystroke field to the key-field you wish to change.
  265.  
  266.    By default, Delete-to-End-of-Line is assigned the keys <Ctrl-End> and
  267. <Ctrl-Y>.  Since a function may be assigned a maximum of two keystrokes, the
  268. new <F1> assignment will have to replace one of these.  Decide which key to
  269. replace and make it the active field by using the arrow keys.
  270.  
  271.    Finally, press the <F1> key.  <F1> will be immediately assigned to the
  272. active keystroke field.  If <F1> had already been assigned to another
  273. function, ANARKED would have automatically removed it and beeped to tell you
  274. so.
  275.  
  276.    As another example, say you do not want any possibility of accidently
  277. invoking the Clear-History-Buffer function.  You can, in effect, remove this
  278. command from ANARKEY by clearing all keystrokes assigned to it via <Ctrl-@>.
  279.  
  280.    That's all there is to it!
  281.  
  282.  
  283.  
  284.                           The ANARKED Action Menu
  285.                           -----------------------
  286.  
  287.    Operations other than keystroke assignments are performed by choosing a
  288. selection from the Action Menu.  The Action Menu is activated by pressing
  289. the <Esc> key.  Once active, the Action Menu provides the abilities to:
  290.  
  291.                -- save your editing changes and quit ANARKED,
  292.                -- create a summary file of the ANARKEY
  293.                   functions and their assigned keystrokes,
  294.                -- assign one of the action keys to a function,
  295.                -- clear the active keystroke field and
  296.                -- quit ANARKED without saving your changes.
  297.  
  298.    The Action Menu's active operation is displayed in inverse video.
  299. Pressing the Up and Down arrow keys will cycle the active operation through
  300. the available choices.  Pressing <Enter> will execute the active operation.
  301. Some operations are executed immediately, while others require additional
  302. input before executing.  If additional input is required, ANARKED will
  303. prompt you for it.  To exit the Action Menu, press <Esc>.
  304.  
  305.    Each Action Menu operation is explained below.
  306.  
  307. --- Save changes and quit
  308. -------------------------
  309.    This operation saves the current keystroke configuration to the output
  310. file specified during startup.  Since ANARKED modifies the ANARKEY.COM disk
  311. file, the new keystroke assignments will not take effect until the next time
  312. ANARKEY is installed.
  313.  
  314.    After writing the output file, ANARKED terminates and you are returned to
  315. the DOS command prompt.
  316.  
  317. --- Create summary list
  318. -----------------------
  319.    Executing this menu option will create a summary listing of ANARKEY
  320. functions and their current keystroke assignments.  The listing may be saved
  321. to a disk file or sent directly to a printer for use as a quick and handy
  322. reference when first learning ANARKEY.  You will be prompted for the
  323. summary's destination.
  324.  
  325.    To save the summary to a disk file, you may accept the displayed default
  326. destination or enter a different file specification with optional drive and
  327. path.  The default file spec will be the same as the output file you
  328. specified at ANARKED startup, but with a ".SUM" extension.  For example, if
  329. you specified the output file to be:
  330.  
  331.                         C:\BIN\ANARKEY.COM
  332.  
  333. then the default summary file will be:
  334.  
  335.                         C:\BIN\ANARKEY.SUM
  336.  
  337.    To accept the default, simply press <Enter> when prompted for the
  338. destination.
  339.  
  340.    To send the summary information to a printer, enter "PRN" when prompted
  341. for the destination.  The printer must be on-line and active BEFORE sending
  342. anything to it.  Check and be sure this is the case before you attempt to
  343. print or you may lose your current editing session.
  344.  
  345.    Pressing <F1> will abort the operation without creating a summary list.
  346.  
  347.    Tip: By defining an AKA that loads the summary file into your favorite
  348. word processor or file-viewing program, an on-line help facility can be
  349. created.  For example:
  350.  
  351.                     :help   editor c:\bin\anarkey.sum
  352.  
  353. --- Assign action key
  354. ---------------------
  355.    The seven action keys (Up, Down, Left and Right arrow keys, <PgUp>,
  356. <PgDn> and <Esc>) are used to execute special ANARKED operations.  To assign
  357. one of these keys to an ANARKEY function requires going through this Action
  358. Menu option.
  359.  
  360.    When this operation is chosen from the Action Menu, the next keystroke
  361. will be directly assigned to the active keystroke field.  The keystroke will
  362. not be interpreted by ANARKED.  Thus, pressing one of the action keys will
  363. assign that key to the active field.  If the key was already assigned to a
  364. function, ANARKED will beep to inform you it is removing the previous
  365. assignment.
  366.  
  367.    Although this method is mainly used to assign one of the action keys, any
  368. keystroke (except <F1>) will be assigned to the active keystroke field.
  369.  
  370.    Pressing <F1> will abort the operation without performing a keystroke
  371. assignment.
  372.  
  373. --- Remove keystroke (<Ctrl-@>)
  374. -------------------------------
  375.    When this operation is chosen, the active keystroke field is cleared of
  376. the keystroke currently assigned to it.
  377.  
  378.    This operation is equivalent to pressing <Ctrl-@> in a command/keystroke
  379. window.  The Action Menu operation is provided in case you forget <Ctrl-@>
  380. or if <Ctrl-@> is too difficult or not possible to enter.
  381.  
  382. --- Quit ANARKED without save
  383. -----------------------------
  384.    ANARKED will terminate immediately without saving your editing changes to
  385. the output file.
  386.  
  387.  
  388.  
  389.                      All Keyboards are NOT Created Equal
  390.                      -----------------------------------
  391.  
  392.    ANARKED will recognize as many keystrokes as your system's hardware and
  393. firmware support.
  394.  
  395.    Some systems have enhanced keyboards containing <F11> and <F12> keys.
  396. Unfortunately, the system BIOS on many of these machines will not recognize
  397. the extra keys.  If the BIOS will not recognize a key then ANARKED will not
  398. recognize it either.
  399.  
  400.    If your keyboard has <F11> and <F12> keys and ANARKED does not recognize
  401. them, please do not assume there is a problem with ANARKED.  More likely the
  402. fault lies with your machine's BIOS.
  403.  
  404.    Also, because ANARKEY must work in conjunction with so many other
  405. programs, it must be extremely well-behaved.  This means it must get its
  406. keyboard input from a level far-removed from your system's hardware.  Other
  407. programs that do not need to be so well-behaved may be able to access
  408. hardware directly.  Thus, these programs may be able to recognize certain
  409. keystrokes, such as <F11>, that ANARKED cannot.  Again, the problem is not
  410. due to some lack in ANARKED, but rather to the circumstances in which it
  411. must operate.
  412.  
  413.    Please do not deluge me with bug reports about how ANARKED does not
  414. recognize certain keystrokes.  If you truly happen to come upon a common
  415. keystroke, for example, <Alt-F1>, that ANARKED does not accept, I would like
  416. to know.  But if you're pressing your <F11> and <F12> keys and nothing is
  417. happening, the problem lies elsewhere.
  418.  
  419.  
  420.  
  421.                            Comments and Suggestions
  422.                            ------------------------
  423.  
  424.    I would love to hear your suggestions, comments, and enhancement ideas
  425. concerning ANARKED and the other programs in the ANARKEY software package.
  426. Please send your suggestions to:
  427.  
  428.                                 Steven Calwas
  429.                                Moderne Software
  430.                                 P.O. Box 3638
  431.                           Santa Clara, CA 95055-3638
  432.  
  433.                               _______
  434.                          ____|__     |               (tm)
  435.                       --|       |    |-------------------
  436.                         |   ____|__  |  Association of
  437.                         |  |       |_|  Shareware
  438.                         |__|   o   |    Professionals
  439.                       -----|   |   |---------------------
  440.                            |___|___|    MEMBER
  441.  
  442.